Extension point configuration
In component org.nuxeo.runtime.ConfigurationService
Documentation
The configuration extension point allows to define named properties.
Properties can be marked as list and if defined many times, values will be appended as comma separated values.
You can override existing list property with the override attribute.
Example:
<property name="nuxeo.jsf.enableDoubleClickShield">true</property>
<property name="nuxeo.jsf.useAjaxTabs">false</property>
<property list="true" name="nuxeo.list.value">foo</property>
<property name="nuxeo.list.value">bar</property>
<property name="nuxeo.list.value" override="true">I'd like to make sure value is not foo,bar anymore</property>
Contribution Descriptors
- Class: org.nuxeo.runtime.services.config.ConfigurationPropertyDescriptor
Existing Contributions
Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.
-
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="metrics.streams.interval">60s</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that disables checks on package version when updating the Studio package from the admin tab. </documentation> <property name="studio.snapshot.disablePkgValidation">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> URL base for Javadoc Links. </documentation> <property name="org.nuxeo.apidoc.javadoc.url"> https://community.nuxeo.com/api/ </property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> URL base for Connect Links (for Marketplace Packages). </documentation> <property name="org.nuxeo.apidoc.connect.url"> https://connect.nuxeo.com/nuxeo/site/ </property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Default groups for application managers and readers. </documentation> <property name="org.nuxeo.apidoc.apidocmanagers.group"> ApidocManagers </property> <property name="org.nuxeo.apidoc.apidocreaders.group"> Everyone </property> </extension> -
<?xml version='1.0' encoding='UTF-8'?> <extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Properties controlling sensitive configuration exposure, when extracted from runtime contributions by explorer logics. @since 20.0.0 </documentation> <property name="org.nuxeo.apidoc.secure.xml.keywords"> password, Password, secret, apiKey, TMPDIR, TMP, TEMP, TEMPDIR </property> <property name="org.nuxeo.apidoc.secure.xml.keywords.whitelisted"> passwordField, passwordHashAlgorithm </property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Configuration property allowing to use an Automation Chain to retrieve the blob to preview in ARender Previewer. The value is empty by default in order to always return the asked blob and not a low resolution. If you want to enable the low resolution behavior just contribute the following: <code> <extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="nuxeo.arender.low.resolution.chain">Document.ARenderGetBlob</property> </extension> </code> </documentation> <property name="nuxeo.arender.low.resolution.chain"/> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> This contribution is the default contribution for automation properties. Here are more details about some of them: <ul> <li> <strong>nuxeo.automation.properties.value.trim</strong>: properties are expected to be of the form "key=value". You may wish to trim the potential spaces around value (e.g.: "key = value", will result in "value" and not " value"). </li> <li> <strong>nuxeo.automation.export.aliases</strong>: if true, add an operation documentation for each alias of a given operation. Mainly to be backward compatible with old Java Automation client. </li> <li> <strong>nuxeo.automation.allowVirtualUser</strong>: define whether virtual user (non-existent user) is allowed in Nuxeo automation. If allowed, Nuxeo server will not check the user existence during automation execution. Set this property to true if you use Nuxeo computed user or computed group. </li> </ul> @since 8.2 </documentation> <property name="nuxeo.automation.properties.value.trim">false</property> <property name="nuxeo.automation.export.aliases">false</property> <property name="nuxeo.automation.allowVirtualUser">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="org.nuxeo.ignore.empty.searchterm">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> If true listener will recursive on children of document by paginate them. <p/> Default behavior is to fetch all children once. @since 8.10-HF05, 9.2 </documentation> <property name="nuxeo.bulkLifeCycleChangeListener.paginate-get-children">false</property> <documentation> If "nuxeo.bulkLifeCycleChangeListener.paginate-get-children" is true, this property set the page size for get children calls. @since 8.10-HF05, 9.2 </documentation> <property name="nuxeo.bulkLifeCycleChangeListener.get-children-page-size">500</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Configuration property (true or false) controlling whether ACLs on versions are disabled. The value "legacy" is also possible, to disable for direct access but enable for queries. @since 11.3 </documentation> <property name="org.nuxeo.version.acl.disabled">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Configuration property (true or false) controlling whether the ReadVersion permission is disabled. @since 11.3 </documentation> <property name="org.nuxeo.version.readversion.disabled">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property defining the name of the key/value store used for the KeyValueStoreUIDSequencer. </documentation> <property name="nuxeo.uidseq.keyvaluestore.name">sequence</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property defining the restricted aspect when creating a (live) proxy. @since 2021.17 </documentation> <property name="org.nuxeo.proxy.creation.restricted">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Delay before a blob which has had its digest computed asynchronously is deleted. @since 2021.9 </documentation> <property name="nuxeo.blobmanager.delete.delay">1h</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that defines the max length of the document name, which is mainly used to build the document path. </documentation> <property name="nuxeo.path.segment.maxsize">24</property> <documentation> Property that defines if a transient username should be unique no matter what base username is provided, or if a transient username should be always the same for a given base username. @since 10.3 </documentation> <property name="nuxeo.transient.username.unique">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Enable Legacy behavior (Nuxeo 6.x) on ACL order of execution. On Nuxeo 6.x and below, the ACL execution order used to be Inherited -> Local -> LocalGroup (custom), on >7.x it's Inherited -> LocalGroup (custom) -> Local. This flag enables Legacy ACL mode on newer Nuxeo versions 7.x and above. </documentation> <property name="nuxeo.security.acl.legacyBehavior">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enforces the source mime type check when calling a converter. Defaults to true. @since 10.3 </documentation> <property name="nuxeo.convert.enforceSourceMimeTypeCheck">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enables returning blob URLs with redirections already taken into account. Only applies to code calling the DownloadService.getFullDownloadUrl API. </documentation> <property name="org.nuxeo.download.url.follow.redirect">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that defines the default maxPageSize to use when no value is defined on the page provider contribution. Value '0' means no limit. </documentation> <property name="nuxeo.pageprovider.default-max-page-size">1000</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property to disable the fact that on MongoDB a LIKE match anchors its search (like in SQL databases), i.e., absent wildcards, it does not match in the middle of a string. When true, does not match in the middle of a string. When false, works as if there was a % on each side of the LIKE expression. @since 10.3 </documentation> <!-- default is true for 10.3 and later --> <property name="nuxeo.mongodb.like.anchored">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property to disable the cursor timeout on the GC markReferencedBlobs query. @since 2021.14 </documentation> <property name="nuxeo.mongodb.gc.noCursorTimeout">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enables the old legacy date format 'MM/dd/yyyy' instead of the W3C format when reading dates on CSV files. Defaults to false. @since 10.3 </documentation> <property name="nuxeo.csv.import.legacyDateFormat">false</property> <documentation> Property to trim values of the CSV files. Defaults to true. @since 2025.0 </documentation> <property name="nuxeo.csv.import.trim">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> If true, when adapting a document to a FileSystemItem, don't perform the RemoveChildren check on the parent to compute canDelete nor the check on AddChildren to compute canCreateChild. @since 8.10 </documentation> <property name="org.nuxeo.drive.permissionCheckOptimized">true</property> <documentation> If true, reset synchronization root registrations on a copied document and its children. @since 9.1 </documentation> <property name="org.nuxeo.drive.resetSyncRootsOnCopy">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Properties for relaxing the CMIS specifications. Note that setting any property of them to true gives a behavior that is contrary to the CMIS specification. Please be aware the risk of doing so. <ul> <li> "org.nuxeo.cmis.relaxSpec": Relaxing CMIS specification control, default to false. Setting this property to true allows users to relax the CMIS specification and use customized CMISQL. It allows multiple CONTAINS in CMISQL, contrary to the specification 1.1, section 2.1.14.2.4.4, where at most one CONTAINS() function must be included in a single query statement. Currently, JOIN predicate is not supported in such mode. This relax mode must NOT be used with DBS (Document-Based Storage), like MongoDB. </li> <li> "org.nuxeo.cmis.errorOnCancelCheckOutOfDraftVersion": Property that makes it an error to call CMIS cancelCheckOut on a draft version (0.0). </li> </ul> </documentation> <property name="org.nuxeo.cmis.errorOnCancelCheckOutOfDraftVersion">false</property> <property name="org.nuxeo.cmis.relaxSpec">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> This contribution is the default contribution for permissions properties. Here are more details about some of them: <ul> <li> <strong>nuxeo.permissions.acl.enricher.compatibility</strong>: if true, make the ACLJsonEnricher output compatible with the Nuxeo 6.0 'acls' enricher output. It duplicates the 'aces' array in the 'ace' field. </li> </ul> @since 9.1 </documentation> <property name="nuxeo.permissions.acl.enricher.compatibility">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="nuxeo.actions.debug.log_min_duration_ms">-1</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Configuration property allowing to override the operation called when completing the redaction. The value is empty by default in order to execute the default behavior and have backward compatibility (NEV still calls ARenderRedactCompletion automation). If you want to override the redact completion behavior just contribute the following: <code> <extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="nuxeo.arender.override.redact.completion">CustomARenderRedactCompletion</property> </extension> </code> </documentation> <property name="nuxeo.arender.override.redact.completion"/> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="org.nuxeo.ecm.platform.comment.service.notification.autosubscribe">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enables resetting creator, creation date and last modification date on document copy. </documentation> <property name="nuxeo.dclistener.reset-creator-on-copy">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Properties controlling if the picture migration script must be run at startup </documentation> <property name="nuxeo.picture.migration.enabled">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property to set the oauth2 token expiration duration. Default is 60 minutes. @since 2021.14 </documentation> <property name="nuxeo.oauth2.token.expiration.duration">60m</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Properties for core queries behaviors: <ul> <li>org.nuxeo.query.builder.ignored.chars: defines what characters that are escaped in core queries.</li> <li> org.nuxeo.ecm.platform.query.nxql.defaultNavigationResults: <a href="https://doc.nuxeo.com/x/FQ4z#ContentViews-maxresults" target="_blank"> Maximum number of results for page providers. </a> </li> </ul> </documentation> <property name="org.nuxeo.query.builder.ignored.chars">!#$%&'()+,./\\\\:-@{|}`^~</property> <property name="org.nuxeo.ecm.platform.query.nxql.defaultNavigationResults">200</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enables sanitization on tags. </documentation> <property name="nuxeo.tag.sanitization.enabled">true</property> </extension> -
<?xml version='1.0' encoding='UTF-8'?> <extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Controls whether we check the validity of password when changing it. @since 8.4 </documentation> <property name="nuxeo.usermanager.check.password">********</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Controls whether the UserManager.searchUsers(pattern) and UserManager.searchGroups(pattern) APIs interpret the pattern as a generic string with arbitrary characters that will be matched exactly (depending on the directory substring match style) (non-compat mode), or as a LIKE pattern where % and _ are interpreted as LIKE escapes (compat mode). @since 11.1 </documentation> <property name="nuxeo.usermanager.search.escape.compat">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that allows to disable strict CORS checks when a request has Origin: null. This may happen for local files, or for a JavaScript-triggered redirect. Setting this to true may expose the application to CSRF problems from files locally hosted on the user's disk. @since 10.3 </documentation> <property name="nuxeo.cors.allowNullOrigin">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Properties controlling idempotent requests TTL and KeyValue storename. Default TTL in seconds matches 1 day. @since 11.5 </documentation> <property name="org.nuxeo.request.idempotency.ttl.duration">1d</property> <property name="org.nuxeo.request.idempotency.keyvaluestore.name">idempotentrequest</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enables or disables zip files preview. </documentation> <property name="nuxeo.preview.zip.enabled">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property that enables or disables sanitization on zip files preview. </documentation> <property name="nuxeo.preview.zip.sanitize.enabled">true</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property controlling the scroll size when clearing quota size. @since 11.1 </documentation> <property name="nuxeo.quota.clear.scroll.size">500</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property controlling the scroll lifetime when clearing quota size. @since 11.1 </documentation> <property name="nuxeo.quota.clear.scroll.keepAliveSeconds">60</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property controlling the scroll size when initialising quota size. @since 11.1 </documentation> <property name="nuxeo.quota.init.scroll.size">250</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Property controlling the scroll lifetime when initialising quota size. @since 11.1 </documentation> <property name="nuxeo.quota.init.scroll.keepAliveSeconds">120</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="nuxeo.document.routing.escalation.running.flag.ttl.duration">3m</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Delay Quartz scheduler start to avoid unique key constraint violation with qrtz_LOCKS table <p/> Default behavior is to delay for 5 seconds. @since 2021.19 </documentation> <property name="org.nuxeo.scheduler.start.delay">5s</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> Configuration property for enabling backward compatibility with scripting parameters where context variables were inlined. </documentation> <property name="nuxeo.automation.scripting.inline-context-in-params">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <property name="nuxeo.core.bulk.scroller.scroll.size">200</property> <property name="nuxeo.core.bulk.scroller.scroll.keepAliveSeconds">300</property> <property name="nuxeo.core.bulk.scroller.transactionTimeout">2d</property> <property name="nuxeo.core.bulk.scroller.produceImmediate">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <documentation> This contribution is the default contribution for user profile properties. Here are more details about some of them: <ul> <li> <strong>nuxeo.userprofile.enricher.compatibility</strong>: if true, make the UserProfileEnricher output compatible with the Nuxeo 8.10 'userprofile' enricher output. Only output 'avatar', 'birthdate' and 'phonenumber' fields. </li> </ul> @since 9.3 </documentation> <property name="nuxeo.userprofile.enricher.compatibility">false</property> </extension> -
<extension point="configuration" target="org.nuxeo.runtime.ConfigurationService"> <!-- enrichers --> <property list="true" name="org.nuxeo.web.ui.enrichers.document">hasContent</property> <property name="org.nuxeo.web.ui.enrichers.document">firstAccessibleAncestor</property> <property name="org.nuxeo.web.ui.enrichers.document">permissions</property> <property name="org.nuxeo.web.ui.enrichers.document">breadcrumb</property> <property name="org.nuxeo.web.ui.enrichers.document">preview</property> <property name="org.nuxeo.web.ui.enrichers.document">favorites</property> <property name="org.nuxeo.web.ui.enrichers.document">subscribedNotifications</property> <property name="org.nuxeo.web.ui.enrichers.document">thumbnail</property> <property name="org.nuxeo.web.ui.enrichers.document">renditions</property> <property name="org.nuxeo.web.ui.enrichers.document">pendingTasks</property> <property name="org.nuxeo.web.ui.enrichers.document">runnableWorkflows</property> <property name="org.nuxeo.web.ui.enrichers.document">runningWorkflows</property> <property name="org.nuxeo.web.ui.enrichers.document">collections</property> <property name="org.nuxeo.web.ui.enrichers.document">audit</property> <property name="org.nuxeo.web.ui.enrichers.document">subtypes</property> <property name="org.nuxeo.web.ui.enrichers.document">tags</property> <property name="org.nuxeo.web.ui.enrichers.document">publications</property> <property list="true" name="org.nuxeo.web.ui.enrichers.blob">appLinks</property> <property name="org.nuxeo.web.ui.enrichers.blob">preview</property> <!-- Properties to be fetched when loading current document, default is 'properties' meaning all --> <property list="true" name="org.nuxeo.web.ui.fetch.document">properties</property> <!-- Date (time) format --> <property name="org.nuxeo.web.ui.dateFormat">LL</property> <property name="org.nuxeo.web.ui.dateTimeFormat">LLL</property> <!-- First Day Of Week --> <property name="org.nuxeo.web.ui.firstDayOfWeek"/> <!-- S3 Direct upload --> <property name="org.nuxeo.web.ui.s3.useDirectUpload">false</property> <!-- Redirect to final download url --> <property name="org.nuxeo.web.ui.url.followRedirect">false</property> <!-- Max Results for Tables, Grids and Lists plugged on a Nuxeo Page Provider. Falls back on elasticsearch max result window by default. --> <property name="org.nuxeo.web.ui.listingMaxItems">10000</property> <!-- Control the enablement of document distribution analytics --> <property name="org.nuxeo.web.ui.analytics.documentDistribution.disableThreshold">${nuxeo.analytics.documentDistribution.disableThreshold}</property> <!-- Control the enablement of select all --> <property name="org.nuxeo.web.ui.selection.selectAllEnabled">false</property> <!-- Properties to be fetched when loading the user object in user management, default is empty --> <property list="true" name="org.nuxeo.web.ui.user.management.fetch.document"/> <!-- Max results for nuxeo select options. default is 1000.--> <property name="org.nuxeo.web.ui.pagination.nuxeoSelectOptions.listingMaxItems">1000</property> <!-- allowed url to redirect --> <property name="org.nuxeo.web.ui.trustedDomains"/> <!-- Search result numberFormatting --> <property name="org.nuxeo.web.ui.numberFormatting.enabled"/> <!-- Control eval allowed in CSP, default is true --> <property name="org.nuxeo.web.ui.expressions.eval">true</property> </extension>